Skip to content

README: link Examples/README.md from the More examples section - #90

Merged
kostas-jonauskas merged 1 commit into
mainfrom
readme-link-examples-guide
Nov 10, 2026
Merged

kostas-jonauskas merged 1 commit into
mainfrom
readme-link-examples-guide

Conversation

@tomasr78

Copy link
Copy Markdown
Contributor

What

One sentence in the README's "More examples" section. It now says how to run an example and links https://github.com/ConvertAPI/convertapi-library-dotnet/blob/main/Examples/README.md, which explains how to set CONVERTAPI_TOKEN, run an example with dotnet run --project, and where the sample files are.

The ### More examples heading is unchanged, so links to #more-examples still work.

Why

The section listed all 21 example projects but never said how to run them. #83 and #85 agreed that whichever merged second would add this link, because Examples/README.md existed only on #85's branch until then. Both merged without it.

Checks

  • The link is absolute, like the other example links, so it also works in the copy of this README that nuget.org shows. publish.yml only rewrites utm_source=github links, and this link has no tags.
  • The link returns HTTP 200.
  • The new line is plain ASCII.
  • No CHANGELOG.md entry, because RELEASING.md asks for one only when behaviour changes.

🤖 Generated with Claude Code

The README's More examples section listed the 21 example projects but not
Examples/README.md, which explains how to set CONVERTAPI_TOKEN and run an
example. PRs 83 and 85 agreed that whichever merged second would add this
link. Both merged without it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings November 10, 2026 14:42

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues are reported for the README update adding token setup guidance and a link to the example-running instructions.

No open issues 🎉

What changed in this PR

Connects the main README’s example list to the setup and execution guide, completing the documentation follow-up from #83 and #85.

Changes:

  • Tells readers to set CONVERTAPI_TOKEN before running an example.
  • Adds an absolute link to Examples/README.md, preserving the existing heading anchor and example links.
File Description
README.md Adds token setup guidance and a link to the example-running instructions under “More examples.”

Review effort: Balanced

@kostas-jonauskas
kostas-jonauskas merged commit d726ee3 into main Nov 10, 2026
2 checks passed
@kostas-jonauskas
kostas-jonauskas deleted the readme-link-examples-guide branch November 10, 2026 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants